Atualizar uma Tarifa
Use o seguinte endpoint para editar ou alterar uma tarifa:
PUT 'apisandbox-billing-api.delfinance.com.br/billing-accounts/:billingAccountId'
Headers
Nome | Descrição |
---|---|
x-delfinance-api-key | Required. API key |
Corpo da requisição
Nome | Type | Description |
---|---|---|
bankAccount | string | Obrigatório. Conta bancária que será cobrada |
fees | object | Objeto contendo informações sobre as tarifas |
fees.transactionTypeId | enum | Qual tipo de transação será cobrada do seu cliente? - 7 - TED enviado - 8 - TED recebido - 10 - Pix enviado - 11 - Pix recebido - 12 - Pix reembolsado recebido - 13 - Pix reembolsado enviado - 21 - TED reembolsado - 43 - Reembolso administrativo de Pix - 78 - Pix reembolsado enviado (desfazer transação) - 133 - Pix debitado via MED RDR (desfazer transação) - 9001 - Taxa mensal de custódia- 9002 - Taxa mensal de API |
fees.price | number | Valor a ser cobrado pela tarifa |
fees.feeType | enum | Tipo de valor à ser cobrado, Dominios: fixed - Valor fixo percentage - Porcentagem do valor |
invoiceFrequency | object | Objeto contendo informações da frequência de cobrança da tarifa |
invoiceFrequency.category | object | A frequência em que o cliente será cobrado - minute - A cobrança será ativada a cada minuto- hour - A cobrança será ativada a cada hora- day - A cobrança será ativada todos os dias- week - A cobrança será ativada toda semana- month - A cobrança será ativada todo mês- year - A cobrança será ativada todo ano |
invoiceFrequency.amount | number | Valor que será cobrado em frequência definido |
startDate | date | Data em que o cálculo da tarifa começa. |
nextInvoiceAt | date | Data em que ocorrerá o primeiro pagamento, após esta data será estabelecido a partir da frequência |
Examplo
{
"bankAccount": "123456",
"fees": [
{
"transactionTypeId": 10,
"price": 0.50,
"feeType": "fixed"
}
],
"invoiceFrequency": {
"category": "month",
"amount": 1
},
"startDate": "2023-01-01",
"nextInvoiceAt": "2023-02-01"
}
Resposta
Em caso de resposta bem-sucedida, você receberá um código de status 204